dxp-ux

(0 reviews)

GET BillingAccountByID -TMF666

This operation retrieves a billing account entity used by:

PR - billingAccountID (or) MSISDN (or) client accountId (or) BAN-CAN.
PA and LC - BillingAccountId.

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/{id}

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico	Y
id	string	To retrieve 'account' information provide Billing Account Number or msisdn To retrieve 'balance' information provide account number. Example: msisdn: 17874047209,billingAccountNumber: 33541396-33542750	Y

Note:

For PR, To retrieve 'balance' information need to pass 'targetSystem'.
To retrieve 'account' information need to pass 'lob'.

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y
channelId	string	Expected value APP	Y (PR), N(PA),N/A(LC)
lob	String	Enum: PREPAID, POSTPAID,FIXED Expected value for PR: PREPAID, POSTPAID Expected value for PA: FIXED, POSTPAID	Y (PR), N/A(PA,LC)
targetSystem	String	Expected value "aria".	Y (PR), N(PA),N/A(LC)

Query Parameters

Note: For PR, To retrieve 'account' information need to pass 'extendedCharacteristics.name', 'extendedCharacteristics.value', 'type'.

Name	value	description	required (mandatory-Y, optional-N, Not applicable- N/A)
extendedCharacteristics.name	string	Expected value is sourceSystem	Y(PR), N/A(PA,LC)
extendedCharacteristics.value	string	Expected value is Digital	Y(PR), N/A(PA,LC)
type	string	Need to pass 'billingAccountNumber' or 'msisdn'	Y(PR), N/A(PA,LC)
filter	string	This field is to reduce the BSS operations and to increase the API performance Possible Values: optimize	N/A(PR, LC- Cerillion), N(PA), Y(LC- Liberate)

Data Model - Response:

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)
id	string	Billing Account Number (For PR: Salesforce Record Id)	Y(PA,LC),N(PR)
href	string	URL reference of the billing account in Salesforce	N/A(PA,LC),N(PR)
billable	boolean	The billability of the account	Y(PA), N(LC),N/A(PR,CW)
accountType	string	A categorization of an account, Possible Value - RES	Y (PA,LC),N(PR)
ratingType	string	payment type of the billing account and the options are:Prepaid Postpaid	N/A(PA,LC),N(PR)
description	string	customerType description. For PR: name of the account owner	Y(PA), N(LC),N(PR),N/A(CW)
name	string	name of the billing account	Y(PA), N(LC),N(PR)
state	string	Contains the lifecycle state.	Y(PA,LC),N(PR)
paymentStatus	string	The account's delinquency status or payment status.	Y(PA,LC),N(PR)
lastModified	string	Date of last modification of the account	N/A(PA,LC),N(PR)
autopayEnabled	string	indicator of the Auto Pay enabled	N/A(PA,LC),N(PR)
extendedCharacteristics	array	A list of characteristics that characterize this billingAccount	N/A(PA,LC),N(PR)
extendedCharacteristics.name	string	Name of the characteristic Example: methodType,token,externalPaymentMethodIdentifier	N/A(PA,LC),N(PR)
extendedCharacteristics.value	any	The value of the characteristic Example: BrainTreeToken,639338417,2	N/A(PA,LC),N(PR)
accountBalance[]	array	Balances linked to the account	Y(PA,LC),N(PR)
accountBalance[].balanceType	string	Type of the balance	Y(PA, LC),N(PR)
accountBalance[].amount	object	Balance amount	Y(PA,LC),N(PR)
accountBalance[].amount.unit	string	USD, PAB	Y(PA, LC),N(PR)
accountBalance[].amount.value	number	A positive floating point number	Y(PA, LC),N(PR)
accountBalance[].validFor	object	A period, either as a deadline (endDateTime only) a startDateTime only, or both	N(PA,LC),N(PR)
accountBalance.validFor.endDateTime	datetime or string	End of the time period, using ISO 8601 format Note for PA:This field type is string	N(PA,LC),N(PR)
accountBalance.validFor.startDateTime	datetime or string	Start of the period, using ISO 8601 format. If you define a start, you must also define an end Note for PA:This field type is string	N(PA),N(PR),N/A(LC)
accountRelationship	array	Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its billing account	N(PA,PR),N/A(LC)
accountRelationship.relationshipType	string	Type of relationship.	N/A(PA,LC),N(PR)
accountRelationship.account	object	An account may be a party account or a financial account.	N/A(PA,LC),N(PR)
accountRelationship.account.id	string	Unique identifier Id of the EntityDescriptionRef.	N/A(PA,LC),N(PR)
accountRelationship.account.description	string	Detailed description of the EntityDescriptionRef	N/ (PA,LC),N(PR)
accountRelationship.account.name	string	Name of the account.	N/A(PA,LC),N(PR)
accountRelationship.account.@type	string	When sub-classing, this defines the sub-class entity name	N/A(PA,LC),N(PR)
accountRelationship.validFor.endDateTime	datetime	End of the time period, using ISO 8601 format	N/A(PA,LC),N(PR)
accountRelationship.validFor.startDateTime	datetime	Start of the period, using ISO 8601 format. If you define a start, you must also define an end	N/A(PA,LC),N(PR)
billStructure	object	The structure of the bill for party accounts (billing or settlement).	Y(PA,PR),N(LC)
billStructure.cycleSpecification	object	An attachment by value or by reference.	Y(PA,PR),N/A(CW),N(LC)
billStructure.cycleSpecification.id	string	Unique identifier of the billing cycle specification	Y(PA,PR),N/A(CW),N(LC)
billStructure.cycleSpecification.billingDay	Integer	Customer's billing cycle starts or ends.	Y(PA,PR),N/A(CW),N(LC)
billStructure.cycleSpecification.paymentDueDate	dateTime or string	An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod Note for PA:This field type is string	Y(PA,PR),N/A(CW),N(LC)
billStructure.cycleSpecification.name	string	Expected value "monthly Billing" "bi-monthly billing"	N/A(PA,LC), N(PR)
billStructure.cycleSpecification.dateShift	string	An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.	Y(PA, PR),N/A(LC)
billStructure.cycleSpecification.frequency	string	Possible values are "monthly" or "bi-monthly billing".	N/A (PA,LC),N(PR)
billStructure.presentationMedia[]	array	Bill Presentation Media Ref or Value class	Y(PA), Y(LC),N(PR)
billStructure.presentationMedia[].name	string	Possible values are "Mail","Email, "eBill enabled"	Y(PA), Y(LC),N(PR)
billStructure.presentationMedia[].id	string	Unique identifier of the bill presentation media	Y(PA), Y(LC),N(PR)
contact	array	Contact point for a given account and accessed via some contact medium.	Y(PA), N(LC),N(PR)
contact.name	string	name of the contact	Y(PA),N(PR),N/A(LC)
contact.partyRoleType	string	Identifies what kind of party role type is linked to the contact Ex: Owner	Y(PA), N(LC),N(PR),N/A(CW)
contact.contactMedium	array	Indicates the contact medium that could be used to contact the party. Possible values are	Y(PA), N(LC),N(PR)
contact.contactMedium.mediumType	string	Type of the contact medium, possible values for PR are: "BillingAddress", "Phone" or "PostalAddress".	Y(PA), N(LC),N(PR)
contact.contactMedium.preferred	boolean	If true, it indicates that it is the preferred contact medium. Ex: true,false	Y(PA),N(PR),N/A(LC)
contact.contactMedium.characteristic	object	Any additional characteristic(s) of this contact medium.	Y(PA), N(LC),N(PR)
contact.contactMedium.characteristic.addressLines1	string	The addressLines1	N(LC),N/A(PA,PR,CW)
contact.contactMedium.characteristic.contactType	string	For PR: if mediumType = "Phone" then possible values are "Home","Business"	Y(PA),N(PR),N(LC)
contact.contactMedium.characteristic.city	string	The city	Y(PA), N(LC),N(PR)
contact.contactMedium.characteristic.country	string	The country	Y(PA), N(LC),N(PR)
contact.contactMedium.characteristic.postCode	string	Postcode	Y(PA,CW),N(PR),N(LC)
contact.contactMedium.characteristic.stateOrProvince	string	State or province	Y(PA), N(LC),N(PR)
contact.contactMedium.characteristic.street1	string	Describes the street	Y(PA), N(LC),N(PR)
contact.contactMedium.characteristic.street2	string	Describes the street	Y(PA), N(LC),N/A(PR)
contact.contactMedium.characteristic.phoneNumber	string	phone number of the customer	Y(PA), N(LC) N(PR),N/A(CW)
contact.contactMedium.characteristic.emailAddress	string	email address of the customer	Y(PA), N(LC),N(PR)
contact.contactName	string	A displayable name for that contact	N(LC), N/A(PA,PR)
contact.contactType	string	Type of contact (primary, secondary...)	N(LC),N/A(PA,PR,CW)
contact.relatedParty	object	Related Entity reference	N/A (PA,LC),N(PR)
contact.relatedParty.id	string	last 4 digits of SSN number	N/A (PA,LC),N(PR)
contact.relatedParty.name	string	name of the customer account	N/A (PA,LC),N(PR)
contact.relatedParty.@type	string	hard-coded as "relatedParty"	N/A (PA,LC),N(PR)
creditLimit	object	The maximum amount of money that may be charged to an account	Y(PA), N(LC),N(PR),N/A(CW)
creditLimit.unit	string	USD, PAB	Y(PA), N(LC),N(PR),N/A(CW)
creditLimit.value	integer	value	Y(PA), N(LC),N(PR),N/A(CW)
defaultPaymentMethod	object	The maximum amount of money that may be charged on an account	Y(PA), N(LC),N(PR),N/A(CW)
defaultPaymentMethod.id	string	Unique identifier ID of the default payment method. Possible values for PR are "C" "E" ""	Y(PA), N(LC),N(PR),N/A(CW)
defaultPaymentMethod.name	string	Payment Method Name. Possible values for PR: "Credit Card" "EFT" "Non Default Payment Method" Possible values for PA: "Electronic", "Cash"	Y(PA), N(LC),N(PR),N/A(CW)
financialAccount	object	AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.	Y(PA), N(LC),N(PR),N/A(CW)
financialAccount.id	string	AccountNumber of the financial account. For PR: Hard coded as "2063"	Y(PA), N(LC)),N(PR),N/A(CW)
financialAccount.accountBalance	object	Balances linked to the account	Y(PA), N/A(LC),N(PR),N/A(CW)
financialAccount.accountBalance.balanceType	string	Type of the balance ; DelinquentBalance, LastPaymentAmount, ReceivableBalance	Y(PA), N/A(LC),N(PR),N/A(CW)
financialAccount.accountBalance.amount	string	Balance amount	Y(PA), N/A(LC),N(PR),N/A(CW)
financialAccount.accountBalance.amount.unit	string	USD, PAB	Y(PA), N/A(LC),N(PR),N/A(CW)
financialAccount.accountBalance.validFor	object	A period, either as a deadline (endDateTime only) a startDateTime only, or both	Y(PA), N/A(LC),N(PR),N/A(CW)
financialAccount.accountBalance.validFor.endDateTime	datetime	End of the time period, using ISO 8601 format	Y(PA), N/A(LC),N(PR),N/A(CW)
financialAccount.accountBalance.validFor.startDateTime	datetime	start of the time period	Y(PA), N/A(LC),N(PR),N/A(CW)
financialAccount.@referredType	string	possible value is "financialAccount"	Y(PA), N(LC),N(PR),N/A(CW)
paymentPlan	array	A list of payment plans	Y(PA,LC),N(PR),N/A(CW)
paymentPlan.paymentFrequency	string	Frequency of the payments, such as monthly and bimonthly	Y(PA), N/A(LC),N(PR),N/A(CW)
paymentPlan.planType	string	status of autopsy. possible values are "Auto Pay Enable" , "Auto Pay Disable	Y(PA), N(LC),N(PR),N/A(CW)
paymentPlan.priority	number	Priority of the payment plan. possible values are 0, 1	Y(PA), N(LC),N(PR),N/A(CW)
paymentPlan.@Type	string	this defines the sub-class entity name	Y(PA), N(LC),N(PR),N/A(CW)
paymentPlan.status	string	Status of the payment plan	Y(PA), N(LC),N(PR),N/A(CW)
paymentPlan.paymentMethod	object	A payment method reference	Y(PA), N/A(LC),N(PR),N/A(CW)
paymentPlan.paymentMethod.id	string	internal reference id of the payment method in Salesforce	Y(PA), N/A(LC)),N(PR),N/A(CW)
paymentPlan.extendedCharacteristics	array	A list of characteristics that characterize the payment method details	Y(PA), N/A(LC),N(PR),N/A(CW)
paymentPlan.extendedCharacteristics.name	string	Name of the characteristic	Y(PA), N/A(LC),N(PR),N/A(CW)
paymentPlan.extendedCharacteristics.value	string	Value of the characteristic	Y(PA), N/A(LC),N(PR),N/A(CW)
characteristic	array	Describes a given characteristic of an object or entity through a name/value pair.	N/A(PA,LC),N(PR)
characteristic.name	string	Name of the characteristic."LocationId" "DunningGroup" "DelinquencyDays" "autoPayDate "DebitDay" "CreditScore"	N/A(PA,LC),N(PR)
characteristic.value	any	Value of the characteristic	N/A(PA,LC),N(PR)
relatedParty	array	Related Entity reference	Y(PA,LC),N(PR),N/A(CW)
relatedParty.id	string	Customer Id	Y(PA),N(LC),N(PR),N/A(CW)
relatedParty.name	string	Customer name	Y(PA),N(LC),N(PR),N/A(CW)
relatedParty.role	string	role of the party. "customer"	Y(PA,N(LC),N(PR),N/A(CW)
relatedParty.@baseType	string	When sub-classing, this defines the super-class	Y(PA,N(LC),N/A(PR,CW)
relatedParty.@type	string	When sub-classing, this defines the sub-class entity name	Y(PA),N(LC),N/A(PR,CW)
relatedParty.@referredType	string	Reference type. "customer"	Y(PA),N(LC),N(PR),N/A(CW)
relatedParty.characteristic	array	characteristics of the relatedParty.	Y(PA,LC),N(PR),N/A(CW)
relatedParty.characteristic.name	string	Name of the characteristic.	Y(PA,LC),N(PR),N/A(CW)
relatedParty.characteristic.value	any	Value of the characteristic	Y(PA,LC),N(PR),N/A(CW)
relatedParty.characteristic.value.DocumentType	string	Type of Document	N(LC),N/A(PA,PR,CW)
relatedParty.characteristic.value.DocumentNumber	string	Name of Document	N(LC),N/A(PA,PR,CW)
relatedParty.characteristic.value.DocumentDescription	string	Description of Document	N(LC),N/A(PA,PR,CW)
relatedParty.characteristic.valueType	string	ValueType of the characteristic	Y(PA),N(LC),N(PR),N/A(CW)
@type	string	Type of the reference. "BillingAccount"	Y(PA),N(PR),N/A(LC)
sourceBSS	string	BSS sytem from which the details are retrieved	Y(PA),N(LC), N/A(PR)
legalEntity	string	legal Entity	Y(CW),N/A(PA,PR,LC)

billStructure.presentationMedia subResource - dataModel

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	examples
id	string	Identifier of presentationMedia (can be billMedia or billLanguage)	Y(LC),N/A(PA,PR)	{ "id": "E", "name": "ebill enabled" }, { "id": "en-us", "name": "BillLanguage" }
name	string	name or description of presentationMedia (can be billMedia or billLanguage)	Y(LC),N/A(CW,PA,PR)	{ "id": "E", "name": "ebill enabled" }, { "id": "en-us", "name": "BillLanguage" }

contact[].contactMedium[] subResource - dataModel

mediumType	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	examples
BillingAddress	string	BillingAddress	N(LC)	{ "mediumType": "BillingAddress", "characteristic": { "street1": "a", "street2": "WILLEMSTAD", "city": "WILLEMSTAD", "stateOrProvince": "", "postCode": "" } }
Email	string	Email	N(LC)	{ "mediumType": "Email", "characteristic": { "emailAddress": "agustinterrero@yopmail.com" } }
Telephone	string	Telephone	N(LC),N/A(CW)	{ "mediumType": "Telephone", "characteristic": { "contactType": "HOME", "phoneNumber": "8739532" } }

accountBalance[] subResource - dataModel

balanceType	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	examples
LastPayment Amount	string	Last Payment Amount	N(LC)	{ "amount": { "unit": "XCG", "value": 1 }, "balanceType": "LastPayment Amount", "validFor": { "endDateTime": "2025-09-18T08:43:28-0:00" } }
CurrentBalance	string	Current Balance	N(LC)	{ "amount": { "unit": "XCG", "value": 754.03 }, "balanceType": "CurrentBalance" }
Overdue Amount	string	Overdue Balance	N(LC)	{ "amount": { "unit": "XCG", "value": 754.03 }, "balanceType": "Overdue Amount" }
WrittenOffAmount	string	WrittenOff Amount	N(LC)	{ "amount": { "unit": "XCG", "value": 0 }, "balanceType": "WrittenOffAmount" }
TotalOutstandingBalance	string	Total Outstanding Balance	N(LC)	{ "amount": { "unit": "XCG", "value": 754.03 }, "balanceType": "TotalOutstandingBalance" }
LastBillAmount	string	Last Bill Amount	N(LC)	{ "amount": { "unit": "XCG", "value": 593.29 }, "balanceType": "LastBillAmount", "validFor": { "endDateTime": "2024-01-01T12:00:00-04:00" } }
LedgerBalance	string	Ledger Balance	N(LC),N/A(CW)	{ "amount": { "unit": "JMD", "value": 16014.52 }, "balanceType": "LedgerBalance" }
NetPayable	string	Net Payable	N(LC),N/A(CW)	{ "amount": { "value": 6498.75, "unit": "JMD" }, "balanceType": "NetPayable" }
DepositRequired	string	Deposit Amount	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "DepositRequired" }
TotalQuery	string	Total Query	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "TotalQuery" }
DepositHeld	string	Deposit Held	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "DepositHeld" }
Total Query Tax	string	Total Query Tax	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "Total Query Tax" }
TotalAdjustmentCredit	string	Amount of Total Adjustment Credit	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "TotalAdjustmentCredit" }
TotalDepositPaid	string	Total Deposit Paid amount	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "TotalDepositPaid" }
TotalServiceChargeCredit	string	Total Service Charge Credit	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "TotalServiceChargeCredit" }
TotalRewards	string	Total Rewards	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "TotalRewards" }
TotalAvailablePointsAmount	string	Total Available Points Amount	N(LC),N/A(CW)	{ "amount": { "value": 0.00, "unit": "JMD" }, "balanceType": "TotalAvailablePointsAmount" }

relatedParty[].Characteristic subResource - dataModel

characteristic name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	examples
DocumentType	array	It provides the identity type	N (PA,LC),N/A(CW)	{ "name": "DocumentType", "value": "C" }
DocumentNumber	string	Indicated the identity number	N (PA,LC),N/A(CW)	{ "name": "DocumentNumber", "value": "4-248-586" }
Email	string	Customer's email address	N (PA),N/A(LC)	{ "name": "Email", "value": "argelis.samudio@cwpanama.com" }
Gender	string	Indicates the gender of customer	N (PA,LC),N/A(CW)	{ "name": "Gender", "value": "F" }
Title	string	Provides the Salutation	N (PA,LC),N/A(CW)	{ "name": "Title", "value": "Sra", "valueType": "string" }
FirstName	string	Indicates the first name of customer	N (PA,LC),N/A(CW)	{ "name": "FirstName", "value": "Argelis", "valueType": "string" }
LastName	string	Indicates the last name of customer	N (PA,LC),N/A(CW)	{ "name": "LastName", "value": "Samudio Besada", "valueType": "string" }
OtherName	string	Indicates the other name of customer	N (PA,LC),N/A(CW)	PA: { "name": "OtherName", "value": "Del Carmen", "valueType": "string" }
CompanyName	string	Indicates the company name if the the acccount type is business.	N (PA,LC),N/A(CW)	PA: { "name": "CompanyName", "value": "**", "valueType": "string" }
Date-Of-Birth	string	date of birth of customer	N (PA,LC),N/A(CW)	PA: { "name": "Date-Of-Birth", "value": "1973-05-23T00:00:00-5:00", "valueType": "string" }
Customer Identity	array	this is an array with all the customer identity details.	N (PA,LC),N/A(CW)	PA: { "name": "Customer Identity", "valueType": "array", "value": [ { "DocumentType": "C", "DocumentNumber": "4-248-586", "DocumentDescription": "Cedula" } ] }
BaseAccountType	string	A categorization of an account.	Y(PA,LC), N/A(CW)	{ "name": "BaseAccountType", "value": "RES" }

paymentPlan[] subResource - dataModel

paymentPlan type	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	examples
SupportsRecurringPayments	string	Supports Recurring Payments	N(LC),N/A(CW)	{ "priority": 0, "planType": "W", "status": true, "@Type": "SupportsRecurringPayments" }

Customer Identity Characteristic value Array- SubResource Model

name	type	description	required (mandatory-Y, optional-N, Not applicable- N/A)	examples
DocumentType	string	The type of document	N (PA,LC)	PA: { "DocumentType": "C", "DocumentNumber": "4-248-586", "DocumentDescription": "Cedula" }
DocumentNumber	string	Document ID/ Number.	N (PA,LC)	PA: { "DocumentType": "C", "DocumentNumber": "4-248-586", "DocumentDescription": "Cedula" }
DocumentDescription	string	description of the document	N (PA,LC)	PA: { "DocumentType": "C", "DocumentNumber": "4-248-586", "DocumentDescription": "Cedula" }

Expected values for CSG FIXED Auto Pay

For paymentStatus below are expected fields Delinquency Status or Payment Status

Delinquency Status:

Mule Field Value	BSS Field Value	Description
NORMAL	“” or null	NORMAL
C	C	VOLUNTARY DISC
E	E	NON-PAY DISC
A	A	OPEN NP EQPTACT
F	F	OPEN NP EQPT FT
P	P	PEND NP SVC RES
S	S	PND CHG SERV WO
T	T	PPV RESTRICTED
U	U	DWNGRD-SVCS
V	V	OPEN VOL DISC
W	W	OPEN NP EQPTDIS
Z	Z	CHARGED OFF

Payment Status

Mule Field Value	BSS Field Value	Description
NORMAL	“” or null	NORMAL
S	S	Suspended
B	B	Balance is less than EFT minimum debit amount
D	D	Debit Error
E	E	Prenote Error
G	G	EFT debit had been sent to ACH processor
P	P	Prenote Error
W	W	Waiting

Key considerations

Please refer the responses from following URL: DXP-UX API - BillingAccountByID

PA Implementation:

Account details will be retrieved from Liberate by providing accountNumber as an input.
For better performance for API please use Queryparameter filter=optimize.
Sending LOB as header is not required as this resource deals with the account.
Possible Identity types for Liberate PA are C -Cedula, PP-Pasaporte, SS-Seguro Social, V-Cuenta Vieja.
Possible values for PaymentStatus are "In Arrears", "Active".
Possible values for state:
- W-Activo
- D-Defecto
- C-Cesado
- E-Cierre
- F-Cerrada
- S-Especial
- B-Llamada Prohibida
For all the dateTime fields
- Any datetime before 1908-04-22 will show offset -05:18
- Any datetime on or after 1908-04-22 will show offset -05:00

LC Implementation (Flow markets including CW):

Account details will be retrieved from Liberate and Carillion by providing accountNumber as an input.
For better performance for API please use Queryparameter filter=optimize.
Possible values for PaymentStatus are "In Arrears", "Active".
In the API response, the accountType field will have the value "RES", indicating a Residential account.
In the API response, the possible values for billStructure.presentationMedia are :
- For CWC or Flow Markets: ebill enabled, ebill and paperBill enabled ,paperBill enabled, no bill and ebill disabled.
- For CW Market : ebill enabled, ebill and paperBill enabled ,paperBill enabled, no bill and ebill disabled.
When relatedParty[].characteristic[].name="BaseAccountType", the correspondingrelatedParty[].characteristic[].value represents the base account type.
Possible values of Base AccountType for liberate are:
- BU - Enterprise
- GV - Government
- IN - Internal CWC
- RE - Residential
- WH - Wholesale
Possible values of Base AccountType for cerillion are:
- RES - Residencial
- BUS - Business

Possible values for state for liberate:

- A-Allocated
- W-Working
- B-Call barred
- C-Ceased
- D-Default (but not in TOS)
- E-Written-Off
- F-Closed
- T-Tossed
- O-Debt Outsource
- P-Promise to pay
- S-Cessation (Recommended for Cessation)

Possible values for state for cerillion:

- SF = Final (After Final Bill Generated)
- SN = Normal
- SR = Reactivate (Temporary status to accept payments for Final or Write Off accounts)
- SW = Written off

Possible values for accountType For liberate:

AccountTypes	AccountTypeDesctiption
A	Cellular Pre-paid
B	Business
C	Co-owned Station
D	Diplomat
E	Employee
F	CO-owned residential
G	Government
H	Hospital
I	Internet
J	Cellular Business
K	International Bus
L	Cell Maj acct (res)
M	Corporate Account
N	Cellular Corporate
O	Browse & Talk HFONE
P	PBX & Key System
Q	CWJ CONTRACTORS + CU
RES	Residencial
S	Pensioner
T	Cellular Residential
U	Prepaid Home Fone
V	Non-Pots Customer
W	International Custom
X	Carrier Services
Y	Mobile New Service
Z	Cell VIP/Diplomat

Possible values for accountType for cerillion:

Account Type	Description
RES	Residencial
BUS	Business

Possible values for payment methods for liberate:

Payment Method	Description
(	Online Payments
*	IVR Credit Card
_	Eservice Credit Card
0	** COMVERSE PAYMENT
<	ECOMMERCE VISA CARD
>	Portal Credit Card
@	Recurrng Credit Card
A	CANADIAN
C	CASH
D	DIRECT DEBIT
E	CREDIT CARD
F	DEBIT CARD
G	CUSTOMER DISCOUNT
H	DEALOR PAYMENTS
I	Ecommerce VISA Card
K	IVR Credit Card
L	M-Wallet
M	MANAGER'S CHEQUE
N	C&W Online
O	OTHER / SUNDRY
P	CANADIAN
Q	CHEQUE
R	REDEEM REWARD POINTS
S	salary deduction
T	GCT Withholding TaxC
U	U.S. DOLLARS
V	British Pound
W	Wire Transfer Paymen
X	Staff Bill Payment
Y	CAYMAN DOLLARS
\|	Mobile BillPay App
}	Ecommerce MasterCard

PR Implementation:

FIXED (CSG):

From this operation we can fetch Auto Pay is enabled or disabled, auto-pay date and day, Delinquency status, payment status and payment method EFT or Card.
In the response, if PaymentPlan.planType is AutoPay Enable, AutoPay Date can be displayed in the extended Characteristics else AutoPay Date cannot be displayed.

PREPAID & POSTPAID:

Account details and autopay status are retrieved from Salesforce using billingAccountNumber.
Account details for a PREPAID account are retrieved from Salesforce using MSISDN.
Account details and autopay status are retrieved from Salesforce using MSISDN.
The client account balances are retrieved from Aria.

DC markets.

Account status will be derived using the offers linked to account. if any of the Suspended offers are present in account, then the account state would be considered as "Suspended". Below are the offers list.

OFFER_ID	DISPLAY_VALUE
51002454	CUR Wireline Barring
51006038	CUR Wireless Barring
51006040	CUR Wireless CHCO Barring
51006047	SXM Wireless Barring
51006143	CUR Data Connectivity Barring
51007682	CUR Wireless CHCO Barring up to 10 Members
51007683	CUR Wireless CHCO Barring 11 to 50 Members
51007688	BES Wireless CHCO Barring up to 10 Members
51009190	CUR Wireless Disconnection Fees for Collections
51009192	BES Wireless Disconnection Fees for Collections
51009694	SXM Wireless Disconnection Fees for Collections